home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 July: Mac OS SDK / Dev.CD Jul 97 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Interfaces / PInterfaces / OpenTptSerial.p < prev    next >
Encoding:
Text File  |  1996-02-13  |  5.9 KB  |  202 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        OpenTptSerial.p
  3.  
  4.      Contains:    Definitions for Serial Port
  5.  
  6.      Copyright:    © 1984-1995 by Apple Computer, Inc.
  7.                  All rights reserved.
  8.  
  9. }
  10.  
  11. {$IFC UNDEFINED UsingIncludes}
  12. {$SETC UsingIncludes := 0}
  13. {$ENDC}
  14.  
  15. {$IFC NOT UsingIncludes}
  16.  UNIT OpenTptSerial;
  17.  INTERFACE
  18. {$ENDC}
  19.  
  20. {$IFC UNDEFINED __OPENTPTSERIAL__}
  21. {$SETC __OPENTPTSERIAL__ := 1}
  22.  
  23. {$I+}
  24. {$SETC OpenTptSerialIncludes := UsingIncludes}
  25. {$SETC UsingIncludes := 1}
  26.  
  27.  
  28. {$IFC UNDEFINED __OPENTRANSPORT__}
  29. {$I OpenTransport.p}
  30. {$ENDC}
  31. {    Types.p                                                        }
  32. {        ConditionalMacros.p                                        }
  33. {    MixedMode.p                                                    }
  34. {    Strings.p                                                    }
  35.  
  36. {$PUSH}
  37. {$ALIGN MAC68K}
  38. {$LibExport+}
  39.  
  40. CONST
  41.     COM_SERIAL                    = 'SERL';
  42.  
  43. {}
  44. { Version Number}
  45. {}
  46.     kSerialABVersion    =    '1.0';
  47. {}
  48. { Module Names}
  49. {}
  50.     kSerialABName    =    'serialAB';
  51.     kSerialName        =    'serial';
  52.     kSerialPortAName    =    'serialA';
  53.     kSerialPortBName    =    'serialB';
  54.     kSerialABModuleID            = 7200;
  55.  
  56.     kOTSerialFramingAsync        = $01;                            { Support Async serial mode             }
  57.     kOTSerialFramingHDLC        = $02;                            { Support HDLC synchronous serial mode    }
  58.     kOTSerialFramingSDLC        = $04;                            { Support SDLC synchronous serial mode    }
  59.     kOTSerialFramingAsyncPackets = $08;                            { Support Async "packet" serial mode    }
  60.  
  61. {******************************************************************************
  62. ** IOCTL Calls for Serial Drivers
  63. *******************************************************************************}
  64. { 
  65.      * Set DTR (0 = off, 1 = on)
  66.      }
  67.     I_SetSerialDTR                = 0+(MIOC_SRL_HIGH + 0);
  68.     kOTSerialSetDTROff            = 0;
  69.     kOTSerialSetDTROn            = 1;
  70. {
  71.      * Send a break on the line - kOTSerialSetBreakOff = off, kOTSerialSetBreakOn = on,
  72.      * Any other number is the number of milliseconds to leave break on, then
  73.      * auto shutoff
  74.      }
  75.     I_SetSerialBreak            = 0+(MIOC_SRL_HIGH + 1);
  76.     kOTSerialSetBreakOn            = $ffffffff;
  77.     kOTSerialSetBreakOff        = 0;
  78. {
  79.      * Force XOFF state - 0 = Unconditionally clear XOFF state, 1 = unconditionally set it
  80.      }
  81.     I_SetSerialXOffState        = 0+(MIOC_SRL_HIGH + 2);
  82.     kOTSerialForceXOffTrue        = 1;
  83.     kOTSerialForceXOffFalse        = 0;
  84. {
  85.      * Send an XON character
  86.      * 0 = send only if in XOFF state, 1 = send always
  87.      }
  88.     I_SetSerialXOn                = 0+(MIOC_SRL_HIGH + 3);
  89.     kOTSerialSendXOnAlways        = 1;
  90.     kOTSerialSendXOnIfXOffTrue    = 0;
  91. {
  92.      * Send an XOFF character
  93.      * 0 = send only if in XON state, 1 = send always
  94.      }
  95.     I_SetSerialXOff                = 0+(MIOC_SRL_HIGH + 4);
  96.     kOTSerialSendXOffAlways        = 1;
  97.     kOTSerialSendXOffIfXOnTrue    = 0;
  98.  
  99. {******************************************************************************
  100. ** Option Management for Serial Drivers
  101. *******************************************************************************}
  102. {
  103. ** These options are all 4-byte values.
  104. ** BaudRate is the baud rate.
  105. ** DataBits is the number of data bits.
  106. ** StopBits is the number of stop bits times 10.
  107. ** Parity is an enum
  108. }
  109.     SERIAL_OPT_BAUDRATE            = $0100;                        { UInt32    }
  110.     SERIAL_OPT_DATABITS            = $0101;                        { UInt32    }
  111.     SERIAL_OPT_STOPBITS            = $0102;                        { UInt32 10, 15 or 20 for 1, 1.5 or 2    }
  112.     SERIAL_OPT_PARITY            = $0103;                        { UInt32    }
  113.  
  114.     kOTSerialNoParity            = 0;
  115.     kOTSerialOddParity            = 1;
  116.     kOTSerialEvenParity            = 2;
  117.  
  118. {}
  119. { The "Status" option is a 4-byte value option that is ReadOnly}
  120. { It returns a bitmap of the current serial status}
  121. {}
  122.     SERIAL_OPT_STATUS            = $0104;
  123.     kOTSerialSwOverRunErr        = $01;
  124.     kOTSerialBreakOn            = $08;
  125.     kOTSerialParityErr            = $10;
  126.     kOTSerialOverrunErr            = $20;
  127.     kOTSerialFramingErr            = $40;
  128.     kOTSerialXOffSent            = $0010000;
  129.     kOTSerialDTRNegated            = $0020000;
  130.     kOTSerialCTLHold            = $0040000;
  131.     kOTSerialXOffHold            = $0080000;
  132.     kOTSerialOutputBreakOn        = $1000000;
  133.  
  134. {}
  135. { The "Handshake" option defines what kind of handshaking the serial port}
  136. { will do for line flow control.  The value is a 32-bit value defined by}
  137. { the function or macro SerialHandshakeData below.}
  138. { For no handshake, or CTS handshake, the onChar and offChar parameters}
  139. { are ignored.}
  140. {}
  141.     SERIAL_OPT_HANDSHAKE        = $0105;
  142.  
  143. {}
  144. { These are bits to enable specific types of handshaking}
  145. {}
  146.     kOTSerialXOnOffInputHandshake = 1;                            { Want XOn/XOff handshake for incoming characters    }
  147.     kOTSerialXOnOffOutputHandshake = 2;                            { Want XOn/XOff handshake for outgoing characters    }
  148.     kOTSerialCTSInputHandshake    = 4;                            { Want CTS handshake for incoming characters        }
  149.     kOTSerialDTROutputHandshake    = 8;                            { Want DTR handshake for outoing characters        }
  150.  
  151.     SERIAL_OPT_RCVTIMEOUT        = $0106;
  152.  
  153. {}
  154. { This option defines how characters with parity errors are handled.}
  155. { A 0 value will disable all replacement.  A single character value in the low}
  156. { byte designates the replacement character.  When characters are received with a }
  157. { parity error, they are replaced by this specified character.  If a valid incoming}
  158. { character matches the replacement character, then the received character's msb is}
  159. { cleared. For this situation, the alternate character is used, if specified in bits}
  160. { 8 through 15 of the option long, with 0xff being place in bits 16 through 23.}
  161. { Whenever a valid character is received that matches the first replacement character,}
  162. { it is replaced with this alternate character.}
  163. {}
  164.     SERIAL_OPT_ERRORCHARACTER    = $0107;
  165.  
  166.     SERIAL_OPT_EXTCLOCK            = $0108;
  167.  
  168. {}
  169. { The "BurstMode" option informs the serial driver that it should continue looping,}
  170. { reading incoming characters, rather than waiting for an interrupt for each character.}
  171. { This option may not be supported by all Serial driver}
  172. {}
  173.     SERIAL_OPT_BURSTMODE        = $0109;
  174.  
  175. {}
  176. { Default attributes for the serial ports}
  177. {}
  178.     kOTSerialDefaultBaudRate    = 19200;
  179.     kOTSerialDefaultDataBits    = 8;
  180.     kOTSerialDefaultStopBits    = 10;
  181.     kOTSerialDefaultParity        = kOTSerialNoParity;
  182.     kOTSerialDefaultHandshake    = 0;
  183.     kOTSerialDefaultOnChar        = $11;                            { Control-Q}
  184.     kOTSerialDefaultOffChar        = $13;                            { Control-S}
  185.     kOTSerialDefaultSndBufSize    = 128;
  186.     kOTSerialDefaultRcvBufSize    = 128;
  187.     kOTSerialDefaultSndLoWat    = 96;
  188.     kOTSerialDefaultRcvLoWat    = 1;
  189.     kOTSerialDefaultRcvTimeout    = 4;
  190.  
  191.  
  192. {$ALIGN RESET}
  193. {$POP}
  194.  
  195. {$SETC UsingIncludes := OpenTptSerialIncludes}
  196.  
  197. {$ENDC} {__OPENTPTSERIAL__}
  198.  
  199. {$IFC NOT UsingIncludes}
  200.  END.
  201. {$ENDC}
  202.